docs: add stateChanged and restartRequired reference#1622
Open
Gijsreyn wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds reference documentation for two DSC configuration document functions—stateChanged() and restartRequired()—and links them from the functions overview, expanding the configuration-expression function reference set.
Changes:
- Added new reference page for
stateChanged()including usage guidance and an end-to-end example. - Added new reference page for
restartRequired()including parameter documentation and example usage. - Updated the functions overview page to include the new function entries and link references.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/reference/schemas/config/functions/stateChanged.md | New reference documentation for stateChanged() with description, parameters, and example. |
| docs/reference/schemas/config/functions/restartRequired.md | New reference documentation for restartRequired() with description, parameters, and example. |
| docs/reference/schemas/config/functions/overview.md | Adds stateChanged() and restartRequired() to the system functions list and link references. |
Comment on lines
+101
to
+105
| Type: string | ||
| Required: conditional | ||
| MinimumCount: 0 | ||
| MaximumCount: 1 | ||
| ``` |
Collaborator
Author
There was a problem hiding this comment.
@michaeltlombardi - let's agree to disagree on this one, especially with the text from above?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
This pull request adds both
stateChanged()andrestartRequired()reference documentation.PR Context
Partially addresses #57 (even though it wasn't on the list).